<!doctype html>
<html>
<head>
    <title>Functions (idxCMS: Flat Files Content Management Sysytem ver. 5.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link href="../style.css" type="text/css" rel="stylesheet" />
</head>
<body>
    <div class="page">
        <div class="header center">
            <div class="content">
                idxCMS: Flat Files Content Management Sysytem ver. 5.0                <div class="logo_desc">Application Programming Interface</div>
            </div>
        </div>
        <div class="panel">
            <div class="content">
                <h1>Namespaces</h1>
<ul>
    <li><a href="../administration/package-summary.html">Administration</a></li>
    <li><a href="../catalogs/package-summary.html">Catalogs</a></li>
    <li><a href="../core/package-summary.html">Core</a></li>
    <li><a href="../forum/package-summary.html">Forum</a></li>
    <li><a href="../gallery/package-summary.html">Gallery</a></li>
    <li><a href="../no package/package-summary.html">No Package</a></li>
    <li><a href="../polls/package-summary.html">Polls</a></li>
    <li><a href="../posts/package-summary.html">Posts</a></li>
    <li><a href="../rss/package-summary.html">RSS</a></li>
    <li><a href="../rate/package-summary.html">Rate</a></li>
    <li><a href="../search/package-summary.html">Search</a></li>
    <li><a href="../statistics/package-summary.html">Statistics</a></li>
    <li><a href="../tagcloud/package-summary.html">Tagcloud</a></li>
    <li><a href="../template/package-summary.html">Template</a></li>
    <li><a href="../tools/package-summary.html">Tools</a></li>
    <li><a href="../user/package-summary.html">User</a></li>
</ul>
<h1>Namespace Administration</h1>
    <h2>Functions</h2>
    <ul>
            <li><a href="../administration/package-functions.html#CheckSerialized" title="Administration">CheckSerialized</a></li>
            <li><a href="../administration/package-functions.html#ConvertRightsString" title="Administration">ConvertRightsString</a></li>
            <li><a href="../administration/package-functions.html#FormatSize" title="Administration">FormatSize</a></li>
            <li><a href="../administration/package-functions.html#GetDirSize" title="Administration">GetDirSize</a></li>
            <li><a href="../administration/package-functions.html#GetRights" title="Administration">GetRights</a></li>
            <li><a href="../administration/package-functions.html#GetUnserialized" title="Administration">GetUnserialized</a></li>
            <li><a href="../administration/package-functions.html#InArrayRecursive" title="Administration">InArrayRecursive</a></li>
            <li><a href="../administration/package-functions.html#SaveSortedSections" title="Administration">SaveSortedSections</a></li>
            <li><a href="../administration/package-functions.html#SetRights" title="Administration">SetRights</a></li>
            <li><a href="../administration/package-functions.html#ShowError" title="Administration">ShowError</a></li>
            <li><a href="../administration/package-functions.html#ShowMessage" title="Administration">ShowMessage</a></li>
            <li><a href="../administration/package-functions.html#StatisticsClean" title="Administration">StatisticsClean</a></li>
        </ul>
    <h2>Globals</h2>
    <ul>
            <li><a href="../administration/package-globals.html#BACKUPS" title="Administration">BACKUPS</a></li>
        </ul>
            </div>
        </div>
        <div class="main">
            <div class="content">
                <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../administration/package-summary.html">Namespace</a></li>
                    <li class="active">Function</li>
                    <li>Tree</li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links"><a href="#details_functions">Functions</a></div>
</nav>
                <div class="package">Namespace Administration</div>
<h1>Functions</h1>
<hr />
    <table id="summary_functions" class="title">
        <tr><th colspan="2" class="title">Functions: summary</th></tr>
                    <tr>
                <td class="type w_200">public  boolean|string</td>
                <td class="description">
                    <p><a href="#CheckSerialized"><span class="lilac">CheckSerialized</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$content</span>, <span class="lilac">string</span> <span class="blue">&$content</span>)</p>
                    <p class="description">Checks if file is serialized.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#ConvertRightsString"><span class="lilac">ConvertRightsString</span></a>(<span class="lilac">string</span> <span class="blue">$mode</span>)</p>
                    <p class="description">Translates the string value of the access rights of a file into a numeric value.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#FormatSize"><span class="lilac">FormatSize</span></a>(<span class="lilac">integer</span> <span class="blue">$i</span>)</p>
                    <p class="description">Formats the presentation's file size.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  integer</td>
                <td class="description">
                    <p><a href="#GetDirSize"><span class="lilac">GetDirSize</span></a>(<span class="lilac">string</span> <span class="blue">$dir</span>)</p>
                    <p class="description">Gets size of the directory with subdirectiries.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  string</td>
                <td class="description">
                    <p><a href="#GetRights"><span class="lilac">GetRights</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">boolean</span> <span class="blue">$if</span>)</p>
                    <p class="description">Gets value of the access rights of a file.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  array</td>
                <td class="description">
                    <p><a href="#GetUnserialized"><span class="lilac">GetUnserialized</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>)</p>
                    <p class="description">Gets unserialized data.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#InArrayRecursive"><span class="lilac">InArrayRecursive</span></a>(<span class="lilac">mixed</span> <span class="blue">$needle</span>, <span class="lilac">array</span> <span class="blue">$haystack</span>)</p>
                    <p class="description">Checs if the variable exists in array.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#SaveSortedSections"><span class="lilac">SaveSortedSections</span></a>(<span class="lilac">object</span> <span class="blue">$obj</span>, <span class="lilac">array</span> <span class="blue">$params</span>)</p>
                    <p class="description">Saves sorted sections with categories.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#SetRights"><span class="lilac">SetRights</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">value</span> <span class="blue">$value</span>, <span class="lilac">string</span> <span class="blue">$recursive</span>)</p>
                    <p class="description">Sets access rights of a file.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  void</td>
                <td class="description">
                    <p><a href="#ShowError"><span class="lilac">ShowError</span></a>(<span class="lilac">string</span> <span class="blue">$message</span>, <span class="lilac">string</span> <span class="blue">$url</span>)</p>
                    <p class="description">Shows error.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  void</td>
                <td class="description">
                    <p><a href="#ShowMessage"><span class="lilac">ShowMessage</span></a>(<span class="lilac">string</span> <span class="blue">$message</span>, <span class="lilac">string</span> <span class="blue">$url</span>)</p>
                    <p class="description">Shows message.</p>
                </td>
            </tr>
                    <tr>
                <td class="type w_200">public  boolean</td>
                <td class="description">
                    <p><a href="#StatisticsClean"><span class="lilac">StatisticsClean</span></a>(<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$field</span>)</p>
                    <p class="description">Cleans website statistics.</p>
                </td>
            </tr>
            </table>
    <h2 id="details_functions">Functions</h2>
            <div class="location">admin/modules/_general/filemanager.php at line 120</div>
        <code id="CheckSerialized" class="arguments">public  boolean|string <strong>CheckSerialized</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$content</span>, <span class="lilac">string</span> <span class="blue">&$content</span>)</code>
        <div class="details">
            Checks if file is serialized.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Filename</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$content</td>
                <td class="hid">Content of file</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean|string</td>
                            <td class="hid" colspan="2">Decoded content of file or FALSE</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/modules/_general/filemanager.php at line 22</div>
        <code id="ConvertRightsString" class="arguments">public  string <strong>ConvertRightsString</strong> (<span class="lilac">string</span> <span class="blue">$mode</span>)</code>
        <div class="details">
            Translates the string value of the access rights of a file into a numeric value.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$mode</td>
                <td class="hid">String value of the access rights of a file</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Numeric value of the access rights of a file</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 25</div>
        <code id="FormatSize" class="arguments">public  string <strong>FormatSize</strong> (<span class="lilac">integer</span> <span class="blue">$i</span>)</code>
        <div class="details">
            Formats the presentation's file size.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$i</td>
                <td class="hid">Size value</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">Formatted size value</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 38</div>
        <code id="GetDirSize" class="arguments">public  integer <strong>GetDirSize</strong> (<span class="lilac">string</span> <span class="blue">$dir</span>)</code>
        <div class="details">
            Gets size of the directory with subdirectiries.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$dir</td>
                <td class="hid">The name of the main directory</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid" colspan="2">The size of scanned directory</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/modules/_general/filemanager.php at line 39</div>
        <code id="GetRights" class="arguments">public  string <strong>GetRights</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">boolean</span> <span class="blue">$if</span>)</code>
        <div class="details">
            Gets value of the access rights of a file.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">File to check rights</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$if</td>
                <td class="hid">Check special values</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid" colspan="2">File info</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/modules/_general/filemanager.php at line 92</div>
        <code id="GetUnserialized" class="arguments">public  array <strong>GetUnserialized</strong> (<span class="lilac">string</span> <span class="blue">$file</span>)</code>
        <div class="details">
            Gets unserialized data.<br /> This function can automatically restore broken data.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Filename</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">Unserialized data</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 65</div>
        <code id="InArrayRecursive" class="arguments">public  boolean <strong>InArrayRecursive</strong> (<span class="lilac">mixed</span> <span class="blue">$needle</span>, <span class="lilac">array</span> <span class="blue">$haystack</span>)</code>
        <div class="details">
            Checs if the variable exists in array.<br /> This function is recursive.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">mixed</td>
                            <td class="hid blue w_100">$needle</td>
                <td class="hid">Value to search</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$haystack</td>
                <td class="hid">Array to search</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 80</div>
        <code id="SaveSortedSections" class="arguments">public  boolean <strong>SaveSortedSections</strong> (<span class="lilac">object</span> <span class="blue">$obj</span>, <span class="lilac">array</span> <span class="blue">$params</span>)</code>
        <div class="details">
            Saves sorted sections with categories.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">object</td>
                            <td class="hid blue w_100">$obj</td>
                <td class="hid">Object (posts, forum, etc...)</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid blue w_100">$params</td>
                <td class="hid">Sections data</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/modules/_general/filemanager.php at line 74</div>
        <code id="SetRights" class="arguments">public  boolean <strong>SetRights</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">value</span> <span class="blue">$value</span>, <span class="lilac">string</span> <span class="blue">$recursive</span>)</code>
        <div class="details">
            Sets access rights of a file.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">File to set rights</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">value</td>
                            <td class="hid blue w_100">$value</td>
                <td class="hid">Rights value</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 146</div>
        <code id="ShowError" class="arguments">public  void <strong>ShowError</strong> (<span class="lilac">string</span> <span class="blue">$message</span>, <span class="lilac">string</span> <span class="blue">$url</span>)</code>
        <div class="details">
            Shows error.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$message</td>
                <td class="hid">Message</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$url</td>
                <td class="hid">Url for redirection</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/libs/functions.php at line 133</div>
        <code id="ShowMessage" class="arguments">public  void <strong>ShowMessage</strong> (<span class="lilac">string</span> <span class="blue">$message</span>, <span class="lilac">string</span> <span class="blue">$url</span>)</code>
        <div class="details">
            Shows message.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$message</td>
                <td class="hid">Message</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$url</td>
                <td class="hid">Url for redirection</td>
                    </tr>
        </table>
</div>
        </div>
            <div class="location">admin/modules/_statistics/statistics.php at line 23</div>
        <code id="StatisticsClean" class="arguments">public  boolean <strong>StatisticsClean</strong> (<span class="lilac">string</span> <span class="blue">$file</span>, <span class="lilac">string</span> <span class="blue">$field</span>)</code>
        <div class="details">
            Cleans website statistics.            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$file</td>
                <td class="hid">Name of the file with data</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$field</td>
                <td class="hid">Name of the datafield</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid" colspan="2">The result of operation</td>
                    </tr>
        </table>
</div>
        </div>
                    <nav class="menu_main center"><div class="menu">
            <ul>
                    <li><a href="../index.html">Overview</a></li>
                    <li><a href="../administration/package-summary.html">Namespace</a></li>
                    <li class="active">Function</li>
                    <li>Tree</li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
    <div class="small_links"><a href="#details_functions">Functions</a></div>
</nav>
            </div>
        </div>
    </div>
    <div class="footer">
        <div class="content">
            <div class="copyright center">Generated by <a href="https://github.com/Greenray/phpAPI" target="_blank">phpAPI</a>: PHP Documentation Creator ver. 6.0 &copy; 2015 - 2016 Greenray</div>
        </div>
    </div>
</body>
</html>
